Feature/ba 2656 be setup routing for wagtail and base app pages #313

Hercilio1 · 2025-08-14T12:07:03Z

Acceptance Criteria

Investigate Solution for Router

Investigate how to intercept and prioritize routing requests between Wagtail and BaseApp.
Determine how to reliably detect matching paths in both systems and default to Wagtail when duplicates exist.
Validate whether Wagtail routing can reuse or hook into BaseApp’s existing middleware or router logic.
Validate correct routing priority: Wagtail takes precedence over BaseApp when both match.
Confirm that 404s are returned only when no match exists in either system.
Verify that Wagtail pages served via unified routing use the BaseApp metadata format consistently.

Routing Behavior

Given a URL path is requested that matches both a Wagtail page and a BaseApp page,
when the routing logic is executed,
then the Wagtail page should be served.
Given a URL path is requested that matches only a Wagtail page,
when the routing logic is executed,
then the Wagtail page should be served.
Given a URL path is requested that matches only a BaseApp page,
when the routing logic is executed,
then the BaseApp page should be served.
Given a URL path is requested that matches neither Wagtail nor BaseApp pages,
when the routing logic is executed,
then a 404 response should be returned.
Given a Wagtail page is served via the unified router,
when metadata is rendered,
then it should use the existing BaseApp metadata structure.

URLPath Syncing

Given a Wagtail Page is created or updated,
when the operation completes successfully,
then a corresponding URLPath entry should be created or updated to match the new path.
Given a Wagtail Page is created or updated,
when the URLPath cannot be synced due to a validation error or path conflict,
then a clear and descriptive error message should be returned.
Given a Wagtail Page is deleted,
when the deletion is complete,
then its associated URLPath entry should also be deleted.

URLPath Query Support

Given a valid URLPath exists for a Wagtail Page,
when querying URL-based data in GraphQL,
then the correct path, slug, and page details should be returned.
Given a Wagtail Page is saved with a conflicting or invalid path,
when the system validates the path,
then a meaningful and specific error should be returned.

Backward Compatibility

Given existing functionality relies on baseapp-pages.PageInterface,
when wagtail-grapple and WagtailPageInterface are introduced,
then all existing baseapp-pages features should continue to work without regression.
Given no updates are made to the legacy REST layer,
when endpoints using baseapp-pages are called,
then they should continue to behave as previously defined.

Documentation and Developer Guidance

- Given the integration between baseapp-pages and Wagtail has changed,
when a developer reads internal documentation,
then it should clearly explain how WagtailPageInterface reuses logic from PageInterface.

- Given a developer reviews README files or code comments,
when examining the GraphQL metadata or URL path behavior,
then the updated interface usage should be clearly documented and easy to follow.

Notes

SPIKE Deliverable

Make use of baseapp.pages.URLPath to integrate all URLs in the system and also to allow for Wagtail pages to live in the root like: domain.com/about.

Approvd:
https://app.approvd.io/silverlogic/BA/stories/36399

Setup

Use the template PRs for testing these changes.

Demo

https://www.loom.com/share/7b468c6cbc0b4be4b778d7b63c69bca2

PRs

coderabbitai · 2025-08-14T12:07:10Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feature/BA-2656-be-setup-routing-for-wagtail-and-base-app-pages

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

Visit our Status Page to check the current availability of CodeRabbit.
Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

…ting-for-wagtail-and-base-app-pages

nossila

Nice addition of URLPathFormatter :)

vitorguima · 2025-08-19T19:29:29Z

baseapp_wagtail/base/models.py

+    def pages_url_path(self):
+        """
+        baseapp_pages.models.PageMixin.url_path alternative.
+        Defines a new property because wagtail pages are have have a defined "url_path" property.


@Hercilio1 guess we have a typo here.

vitorguima · 2025-08-19T19:54:00Z

baseapp_wagtail/base/tests/test_graphql_urlpath_query.py

+        self.page.save_revision().publish()
+        self.url_path = self.page.pages_url_path
+
+    def test_urlpath_query_returns_wagtail_page_data(self):


@Hercilio1 are we covering this scenario under the tests?

"Given a URL path is requested that matches both a Wagtail page and a BaseApp page,
when the routing logic is executed,
then the Wagtail page should be served."

Maybe I'm missing something so just want to confirm.

Not following this rule. Didn't like it. If the URLPath exists, it will display an error on the admin/wagtail

## Acceptance Criteria ### Investigate Solution for Router - Investigate how to intercept and prioritize routing requests between Wagtail and BaseApp. - Determine how to reliably detect matching paths in both systems and default to Wagtail when duplicates exist. - Validate whether Wagtail routing can reuse or hook into BaseApp’s existing middleware or router logic. - Validate correct routing priority: Wagtail takes precedence over BaseApp when both match. - Confirm that 404s are returned only when no match exists in either system. - Verify that Wagtail pages served via unified routing use the BaseApp metadata format consistently. ### Routing Behavior - **Given** a URL path is requested that matches both a Wagtail page and a BaseApp page, **when** the routing logic is executed, **then** the Wagtail page should be served. - **Given** a URL path is requested that matches only a Wagtail page, **when** the routing logic is executed, **then** the Wagtail page should be served. - **Given** a URL path is requested that matches only a BaseApp page, **when** the routing logic is executed, **then** the BaseApp page should be served. - **Given** a URL path is requested that matches neither Wagtail nor BaseApp pages, **when** the routing logic is executed, **then** a 404 response should be returned. - **Given** a Wagtail page is served via the unified router, **when** metadata is rendered, **then** it should use the existing BaseApp metadata structure. ### URLPath Syncing - **Given** a Wagtail Page is created or updated, **when** the operation completes successfully, **then** a corresponding `URLPath` entry should be created or updated to match the new path. - **Given** a Wagtail Page is created or updated, **when** the `URLPath` cannot be synced due to a validation error or path conflict, **then** a clear and descriptive error message should be returned. - **Given** a Wagtail Page is deleted, **when** the deletion is complete, **then** its associated `URLPath` entry should also be deleted. ### URLPath Query Support - **Given** a valid `URLPath` exists for a Wagtail Page, **when** querying URL-based data in GraphQL, **then** the correct path, slug, and page details should be returned. - **Given** a Wagtail Page is saved with a conflicting or invalid path, **when** the system validates the path, **then** a meaningful and specific error should be returned. ### Backward Compatibility - **Given** existing functionality relies on `baseapp-pages.PageInterface`, **when** `wagtail-grapple` and `WagtailPageInterface` are introduced, **then** all existing `baseapp-pages` features should continue to work without regression. - **Given** no updates are made to the legacy REST layer, **when** endpoints using `baseapp-pages` are called, **then** they should continue to behave as previously defined. ### ~~Documentation and Developer Guidance~~ ~~- **Given** the integration between `baseapp-pages` and Wagtail has changed, **when** a developer reads internal documentation, **then** it should clearly explain how `WagtailPageInterface` reuses logic from `PageInterface`.~~ ~~- **Given** a developer reviews README files or code comments, **when** examining the GraphQL metadata or URL path behavior, **then** the updated interface usage should be clearly documented and easy to follow.~~ ## Notes ### SPIKE Deliverable Make use of `baseapp.pages.URLPath` to integrate all URLs in the system and also to allow for Wagtail pages to live in the root like: `domain.com/about`. **Approvd:** [https://app.approvd.io/silverlogic/BA/stories/36399](https://app.approvd.io/silverlogic/BA/stories/36399) --- ## Setup - Use the template PRs for testing these changes. ## Demo https://www.loom.com/share/7b468c6cbc0b4be4b778d7b63c69bca2 ## PRs - BE: silverlogic/baseapp-backend#313 - FE: #284 - BE-template: https://bitbucket.org/silverlogic/baseapp-backend-template/pull-requests/173 - FE-template: https://bitbucket.org/silverlogic/baseapp-frontend-template/pull-requests/260

ho-tsl added 8 commits August 12, 2025 20:03

Feat: Connecting Wagtail page to URLPath model

2e248a2

Update: Adding Wagtail object type compatible with PageInterface

6219b0e

Update adding smail rule for formatting urls

385dce8

Update: Adding metadata to Wagtail url path object type

16516a6

Bugfix: Small adjustiment in object_types

3d9b044

Update: Fixing meta_og_type

a6f3f3a

Update: Adding checkers before coupling with other packages

72ed1d0

Update: Solving TODOs

808c81c

Hercilio1 requested review from nossila and vitorguima as code owners August 14, 2025 12:07

ho-tsl added 4 commits August 14, 2025 09:16

Cleaning some unneeded code

4ad2815

Update: Changes due unit tests validations

8a6acd6

Update: Adding unit tests for the urlpath sync process

bbbd1cd

bugfix: fixing the create urlpath sync

5ec6c81

Hercilio1 mentioned this pull request Aug 15, 2025

Feature/ba 2670 fe setup routing for wagtail and base app pages silverlogic/baseapp-frontend#284

Merged

ho-tsl added 6 commits August 15, 2025 12:01

Bugfix: fixing duplicated id issue

91d4b96

freeze setuptools_scm to 8.3.1

f851b85

Remove setuptools_scm frozen version

2b0e848

Merge branch 'epic/wagtail-graphql' into feature/BA-2656-be-setup-rou…

f8853de

…ting-for-wagtail-and-base-app-pages

Update: Improving the sync process btw Wagtail Pages and URLPath

d42bf03

Refactor: changing name of the urlpath_exists method

7e7c709

nossila approved these changes Aug 19, 2025

View reviewed changes

vitorguima approved these changes Aug 19, 2025

View reviewed changes

patsluth-tsl approved these changes Aug 19, 2025

View reviewed changes

Fixing typo

505e299

Hercilio1 merged commit 3c6c812 into epic/wagtail-graphql Aug 20, 2025
4 of 5 checks passed

Hercilio1 deleted the feature/BA-2656-be-setup-routing-for-wagtail-and-base-app-pages branch August 20, 2025 02:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Feature/ba 2656 be setup routing for wagtail and base app pages #313

Feature/ba 2656 be setup routing for wagtail and base app pages #313

Uh oh!

Hercilio1 commented Aug 14, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Aug 14, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Status, Documentation and Community

Uh oh!

nossila left a comment

Uh oh!

vitorguima Aug 19, 2025

Uh oh!

vitorguima Aug 19, 2025

Uh oh!

Hercilio1 Aug 20, 2025

Uh oh!

Uh oh!

Uh oh!

Feature/ba 2656 be setup routing for wagtail and base app pages #313

Feature/ba 2656 be setup routing for wagtail and base app pages #313

Uh oh!

Conversation

Hercilio1 commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Acceptance Criteria

Investigate Solution for Router

Routing Behavior

URLPath Syncing

URLPath Query Support

Backward Compatibility

Documentation and Developer Guidance

Notes

SPIKE Deliverable

Setup

Demo

PRs

Uh oh!

coderabbitai bot commented Aug 14, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Status, Documentation and Community

Uh oh!

nossila left a comment

Choose a reason for hiding this comment

Uh oh!

vitorguima Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

vitorguima Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

Hercilio1 Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Hercilio1 commented Aug 14, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)